/*
 * Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
 * All rights reserved.
 *
 * This file is part of Harmattan SmashMiner OpenGL game application.
 * 
 * Harmattan SmashMiner OpenGL Example Application version 1.0.0
 *  
 * Latest update: 15.4.2011
 *
 * The Harmattan SmashMiner OpenGL example application demonstrates how to use 
 * the OpenGL ES in Harmattan devices.
 *
 * This example is provided as a starting point for 3rd party
 * developers (you) to ease the implementation of OpenGL based 
 * games. Ideas, parts of code or methodologies that this
 * example application uses can be freely used without restrictions.
 *
 * See file README.txt how to build and compile this example application
 * in the Harmattan SDK environment. 
 * 
 * See file INSTALL.txt to find out what is required to run this
 * application and how to install the application to the device or
 * alternatively in QEMU-emulator.
 *
 * The LICENSE.txt file explains the license this software is provided
 * with. A copy of the same license is included in this source file.
 * 
 */

/*
 * Copyright (C) 2011 by Nokia Corporation.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

/// \file spacecraft.h

#ifndef SPACECRAFT_H
#define SPACECRAFT_H

#include "defines.h"     // include this before anything else.

#include "gameobject.h"

/// \enum SpaceCraftMode
enum SpaceCraftMode {
    /// Ball mode. Used when smashing asteroids.
    SpaceCraftBallMode,
    /// Cone mode. Used when collecting items.
    SpaceCraftConeMode };

class SpaceCraft : public WrappingGameObject
{
public:

    SpaceCraft(int, bool);

    friend class GameEngine;
    friend class GameWidget;

    void setMode(SpaceCraftMode);
    SpaceCraftMode mode() const;
    void toggleMode();

    /// Get status of space craft mode transformation
    GLfloat transformationStatus() const { return status; }
    /// Set status of space craft mode transformation
    inline void setTransformationStatus(GLfloat status) { this->status = status; }

    void visible(bool);
    bool isVisible();

    void enabled(bool);
    bool isEnabled();

private:

    /// Mode of spacecraft
    SpaceCraftMode spaceCraftMode;

    /// Transformation status of the mode change of SpaceCraft.
    /// If the transformation status is more than 0.0 and less than 1.0
    /// the ship is transforming from ball mode to cone mode or vice versa.
    /// Is strongly related to GameEngine::modeCone2Ball GameEngine::modeBall2Cone GameEngine::updateSpaceShipGraphics
    GLfloat status;
    /// Is currently visible
    bool spacecraftVisible;
    /// Is currently enabled. Can be steered, can crash or collect items etc.
    bool spacecraftEnabled;
};

#endif // SPACECRAFT_H
